Configuration report templates contain a ReportDefinition page and a ReportSheet page, to access the worksheets that together describe the reports you can produce. CygNet provides a sample report template file ConfigurationTemplate.xlsx for reference. It is stored in the CygNet\Services\FMS\ReportTemplates\Samples folder on your host server.
The ReportDefinition sheet includes the following parameters to describe the type of report to build.
The ReportSheet sheet includes the following sections and corresponding tokens to describe the specific format of the report to build. Valid tokens will be replaced by the values they represent. You may also include additional information you wish to see in the report.
You can enter additional (non-token) elements such as logos, labels, or text into reports. Elements that are not valid token values will be displayed as entered.
Note: This means that tokens with typographical errors, therefore not "valid" tokens, will also be displayed as entered.
Example
[Volume] is a valid token. If you use [Vol] (not a valid token) instead of [Volume], the value will be displayed as "[Vol]" instead of displaying the volume value desired, since [Vol] is not a valid token.
|
[Vol] |
Some tokens use a suffix of _Begin or _End. Such tokens are listed, with both variants shown, in the tables below. In the data table, these tokens will either display the beginning values for a record or the ending values for a record, depending on the appended suffix. Select the token that retrieves the desired data view.
Configuration item tokens have variants you can use to display "last audit" details for several types of data table information. This includes the last Audit Category, Audit Comment, Audit Date (using the host server time zone), Audit User Name, or Change Date associated with the selected configuration item.
Append one of the following to the text of any data table configuration item token to retrieve the indicated value.
Example
The [MeterTubeInsideDiameter_End_LastAuditUserName] token will retrieve the audit record value for the name of the user who last changed the meter tube inside diameter configuration, prior to the end of the record.
The Data Table Tokens subsection below contains a list of configuration item tokens that can be appended with the _Last* tokens listed above.
The ReportDefinition uses parameters to describe the type of report for the service to build. The following parameters determine the described characteristics of your report.
Report parameters, which appear between #ReportParameters# and #End#, can be defined by the following values.
| Parameter | Description | Value |
|---|---|---|
|
ReportName |
The value defined in this cell will be used for the report name, as it will appear in drop-down menus in FMS Explorer and CygNet Explorer. See Using the Reports Control and Scheduling FMS Command Tasks in the MSS for more information. |
Enter a value to be used for the report name. Example Configuration |
|
CommandName |
The value defined in this cell will be used by the service to determine which specific report command type to execute. See FMSClient Methods in the Scripting section for more information. |
Enter a value to specify the report command name. Example CFGR Note: Maximum of 7 characters; letters or numbers only, no spaces. |
Configuration report worksheet parameters, which appear between #Worksheet# and #End#, can be defined by the following values.
| Parameter | Description | Value |
|---|---|---|
|
ReportType |
The value defined in this cell will be used to represent the standard FMS report type you are configuring. |
Enter a value to be used to indicate the type of the report. Example Configuration |
|
NullToken |
The value defined in this cell will be used to represent null values in your report. |
Enter a value to be used to indicate a "null value" cell in the report. Example - |
|
PageBreaks |
The value defined in this cell will be used to specify whether or not to use page breaks in your report. If used, will force a page break after each device within a group. |
Enter a value to indicate whether or not to use page breaks in the report. Options are Yes or No. Default value is Yes. |
|
The value defined in this cell will be used in your report to represent the value for the Group name or Group description fields when either of the following is true.
|
Enter a value to be used to indicate the Group name or Group description when the command was not run against a single group Node. Example [Invalid Group] |
|
|
NodeSortOrder |
The value defined in this cell will be used to specify the order in which to display Node results in the report. |
Enter one of the following options.
Default value is Name ascending. This parameter is optional. |
|
RptStDate |
Note: If you use this parameter in your report template, the RptStDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Configuration Report Definitions (FMS Explorer) or Reports: Configuration (CygNet Explorer) for more information. |
If used, enter a valid start date value for the report. RptStDate and RptEndDate must be the same configuration parameter type. *Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional. |
|
RptEndDate |
Note: If you use this parameter in your report template, the RptEndDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Configuration Report Definitions (FMS Explorer) or Reports: Configuration (CygNet Explorer) for more information. |
If used, enter a valid end date value for the report. RptStDate and RptEndDate must be the same configuration parameter type. *Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional. |
|
RptUnitSet |
Note: If you use this parameter in your report template, the RptUnitSet parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Configuration Report Definitions (FMS Explorer) or Reports: Configuration (CygNet Explorer) for more information. |
If used, enter a valid unit set value for the report. Valid unit set values defined in the service can be viewed through the Admin menu in FMS Explorer. See Configuring Unit Set Definitions for more information. This parameter is optional. |
The ReportSheet uses tokens to describe the format of the report you want to run. The following tokens determine the report content, and will retrieve the corresponding values for display in your report.
Note: Enter report tokens carefully, as the tokens are case sensitive. Typographical errors (therefore not "valid" tokens) will be handled as "additional values" and displayed as entered; the non-token value will appear in your report instead of the actual value(s) the correctly entered token would have retrieved. See Displaying Additional (Non-Token) Values above for more information.
Configuration report headers, which appear above #EndReportHdr#, can be described by the following tokens.
| Token | Description |
|---|---|
| [BeginDateTime] | The start date, in Contract day (C), of the time range for the record |
| [EndDateTime] | The end date, in Contract day (C), of the time range for the record |
| [CmdGroupName] | The name of the group Node against which the command was run, if applicable See also NoCmdGroupToken parameter. |
| [CmdGroupDesc] | The description of the group Node against which the command was run, if applicable
See also NoCmdGroupToken parameter. |
| [GeneratedDateTime] | The time the report was generated, in Local time (L) |
| [TotalDeviceCount] | The total number of devices in the report |
Configuration report subreport headers, which appear between #SubSection# SubReportHeader and #End#, can be described by the following tokens.
| Token | Description |
|---|---|
| General Tokens | |
| [=] | When used as the first three characters, turns the cell into a formula |
| [RowNumber] | The current row number |
| [CurrentDeviceCount] | The index of the device being displayed |
| [TotalDeviceCount] | The total number of devices in the report |
| [NodeContractHour] | The contract hour of the Node |
| [NodeDaysOfData] | The number of days for which the data source of the Node will retain data |
| [NodeDesc] | The Node description |
| [NodeId] | The Node ID |
| [NodeInstallDateTime] | The install date/time for the Node, in Device time (D) |
| [NodeName] | The Node name |
| [NodePollingFacilityId] | The polling facility ID of the Node |
| [NodePollingFacilityTag] | The polling facility tag of the Node |
| [NodePollingSiteService] | The polling Site.Service of the Node |
| [NodeReportingFacilityId] | The reporting facility ID of the Node |
| [NodeReportingSiteService] | The reporting Site.Service of the Node |
| [NodeSecurityApp] | The security application of the Node |
| [NodeSortPriority] | The sort priority of the Node |
| [NodeTimezone] | The time zone configured for the Node |
| [NodeTimezoneUsingDst] | The daylight saving time status of the Node |
| [NodeType] | The Node type |
| [PollingFac_Attr0] -
[PollingFac_Attr29] |
The polling facility indexed text attributes 0 through 29 (each a separate token) |
| [PollingFac_Category] | The polling facility category |
| [PollingFac_Desc] | The polling facility description |
| [PollingFac_Info0] | The polling facility info attribute 0
Default attribute name is Facility Location |
| [PollingFac_Info1] | The polling facility info attribute 1
Default attribute name is Facility Contact |
| [PollingFac_IsActive] | The polling facility active flag |
| [PollingFac_Table0] -
[PollingFac_Table29] |
The polling facility indexed table attributes 0 through 29 (each a separate token) |
| [PollingFac_Type] | The polling facility type |
| [PollingFac_YesNo0] -
[PollingFac_YesNo19] |
The polling facility indexed Yes/No attributes 0 through 19 (each a separate token) |
| [RecordSpan] | The number of minutes in the record span |
Configuration report data table headers, which appear between #SubSection# DataTableHeader and #End#, can be described by the text you enter. Type the desired text into the cell, and format it as desired.
Note: In PDF format, reports containing tables that span multiple pages will repeat the data table header on each contiguous page.
| Token | Description |
|---|---|
| General Tokens | |
| [=] | When used as the first three characters, turns the cell into a formula |
| [NodeId] | The Node ID |
Configuration report data table parameters, which appear between #SubSection# DataTable (1 or 2) and #End#, can be described by the following tokens.
Note: See Displaying Beginning and Ending Values for a Record and Displaying Last Audit Details for a Record for more information about using tokens to display desired configuration information in the data table.
| Token | Description |
|---|---|
| General Tokens | |
| [=] | When used as the first three characters, turns the cell into a formula |
| [FirstRow] | The row number of the first row in the data table |
| [RowNumber] | The current row number |
| [CurrentDeviceCount] | The index of the device being displayed |
| [TotalDeviceCount] | The total number of devices in the report |
| [ConfigLog_Begin_AuditCategory]
[ConfigLog_End_AuditCategory] |
The audit category associated with the configuration log record |
| [ConfigLog_Begin_AuditComment]
[ConfigLog_End_AuditComment] |
The audit comment associated with the configuration log record |
| [ConfigLog_Begin_AuditDate_Host]
[ConfigLog_End_AuditDate_Host] |
The audit date associated with the configuration log record, using the host server time zone |
| [ConfigLog_Begin_AuditUserName]
[ConfigLog_End_AuditUserName] |
The audit user name associated with the configuration log record |
| [NodeContractHour] | The contract hour of the Node |
| [NodeDaysOfData] | The number of days for which the data source of the Node will retain data |
| [NodeDesc] | The Node description |
| [NodeId] | The Node ID |
| [NodeInstallDateTime] | The install date/time for the Node, in Device time (D) |
| [NodeName] | The Node name |
| [NodePollingFacilityId] | The polling facility ID of the Node |
| [NodePollingFacilityTag] | The polling facility tag of the Node |
| [NodePollingSiteService] | The polling Site.Service of the Node |
| [NodeReportingFacilityId] | The reporting facility ID of the Node |
| [NodeReportingSiteService] | The reporting Site.Service of the Node |
| [NodeSecurityApp] | The security application of the Node |
| [NodeSortPriority] | The sort priority of the Node |
| [NodeTimezone] | The time zone configured for the Node |
| [NodeTimezoneUsingDst] | The daylight saving time status of the Node |
| [NodeType] | The Node type |
| [PollingFac_Attr0] -
[PollingFac_Attr29] |
The polling facility indexed text attributes 0 through 29 (each a separate token) |
| [PollingFac_Category] | The polling facility category |
| [PollingFac_Desc] | The polling facility description |
| [PollingFac_Info0] | The polling facility info attribute 0
Default attribute name is Facility Location |
| [PollingFac_Info1] | The polling facility info attribute 1
Default attribute name is Facility Contact |
| [PollingFac_IsActive] | The polling facility active flag |
| [PollingFac_Table0] -
[PollingFac_Table29] |
The polling facility indexed table attributes 0 through 29 (each a separate token) |
| [PollingFac_Type] | The polling facility type |
| [PollingFac_YesNo0] -
[PollingFac_YesNo19] |
The polling facility indexed Yes/No attributes 0 through 19 (each a separate token) |
| [RecordSpan] | The number of minutes in the record span |
| Configuration Item Tokens
*Notes: Append _LastAuditCategory to any configuration item token in order to display the audit category associated with the last-modified audit record. Append _LastAuditComment to any configuration item token in order to display the comment associated with the last-modified audit record. Append _LastAuditDate_Host to any configuration item token in order to display the date associated with the last-modified audit record, using the host server time zone. Append _LastAuditUserName to any configuration item token in order to display the user name associated with last-modified audit record. Append _LastChangeDate to any configuration item token in order to display change date associated with the last-modified audit record. |
|
| [ConfigExceptionCnt_Begin]
[ConfigExceptionCnt_End] |
The number of configuration exceptions for the record |
| [ConfigLogDateTime_Begin]
[ConfigLogDateTime_End] |
The date/time of the configuration log Note: You cannot append additional tokens to [ConfigLogDateTime_Begin] or [ConfigLogDateTime_End]. |
| [ConfigLogSource_Begin]
[ConfigLogSource_End] |
The source of the configuration log
See Configuration Source for more information. |
| [AGA3ExpandedRange_Begin]
[AGA3ExpandedRange_End] |
See FMS Configuration Items for descriptions of these items. |
| [AGA8ExpandedRange_Begin]
[AGA8ExpandedRange_End] See AGA 8 Data Ranges for more information. |
|
| [AtmosphericPressure_Begin]
[AtmosphericPressure_End] |
|
| [BaseCompressibilityOfAir_Begin]
[BaseCompressibilityOfAir_End] |
|
| [BasePressure_Begin]
[BasePressure_End] |
|
| [BaseTemperature_Begin]
[BaseTemperature_End] |
|
| [CalibrationFactor_Begin]
[CalibrationFactor_End] |
|
| [ConeCoefficientThermalExpansion_Begin]
[ConeCoefficientThermalExpansion_End] |
|
| [ConeDiameter_Begin]
[ConeDiameter_End] |
|
| [ConeMaterial_Begin]
[ConeMaterial_End] |
|
| [ConeRefTemp_Begin]
[ConeRefTemp_End] |
|
| [ContractHour_Begin]
[ContractHour_End] |
|
| [CoriolisCalibrationPressure_Begin]
[CoriolisCalibrationPressure_End] |
|
| [CoriolisPressureEffect_Begin]
[CoriolisPressureEffect_End] |
|
| [DeviceDesc_Begin]
[DeviceDesc_End] |
|
| [DeviceName_Begin]
[DeviceName_End] |
|
| [DeviceType_Begin]
[DeviceType_End] |
|
| [DischargeCoefficient_Begin]
[DischargeCoefficient_End] |
|
| [DischargeCoefficientCalc_Begin]
[DischargeCoefficientCalc_End] |
|
| [DpAlarmHigh_Begin]
[DpAlarmHigh_End] |
|
| [DpAlarmLow_Begin]
[DpAlarmLow_End] |
|
| [DpBackflowAlarm_Begin]
[DpBackflowAlarm_End] |
|
| [DpCalibrateHigh_Begin]
[DpCalibrateHigh_End] |
|
| [DpCalibrateLow_Begin]
[DpCalibrateLow_End] |
|
| [DpTapsType_Begin]
[DpTapsType_End] |
|
| [DpTransducerRangeLow_Begin]
[DpTransducerRangeLow_End] |
|
| [DpTransducerRangeHigh_Begin]
[DpTransducerRangeHigh_End] |
|
| [Elevation_Begin]
[Elevation_End] |
|
| [FixedTemp_Begin]
[FixedTemp_End] |
|
| [FlowRateAlarmHigh_Begin]
[FlowRateAlarmHigh_End] |
|
| [FlowRateAlarmLow_Begin]
[FlowRateAlarmLow_End] |
|
| [FluidType_Begin]
[FluidType_End] |
|
| [FpvCalc_Begin]
[FpvCalc_End] |
|
| [GasExpansionFactorCalc_Begin]
[GasExpansionFactorCalc_End] |
|
| [HvCalc_Begin]
[HvCalc_End] |
|
| [IntegralValueVariables_Begin]
[IntegralValueVariables_End] |
|
| [IsentropicExponent_Begin]
[IsentropicExponent_End] |
|
| [KFactorMass_Begin]
[KFactorMass_End] |
|
| [KFactorVolume_Begin]
[KFactorVolume _End] |
|
| [LowFlowCutoffDp_Begin]
[LowFlowCutoffDp_End] |
|
| [LowFlowCutoffFlowRate_Begin]
[LowFlowCutoffFlowRate_End] |
|
| [LowFlowCutoffMass_Begin]
[LowFlowCutoffMass_End] |
|
| [LowFlowCutoffPulseInterval_Begin]
[LowFlowCutoffPulseInterval_End] |
|
| [MeterFactor_Begin]
[MeterFactor_End] |
|
| [MeterTubeInsideDiameter_Begin]
[MeterTubeInsideDiameter_End] |
|
| [MeterTubeMaterial_Begin]
[MeterTubeMaterial_End] |
|
| [MeterTubeRefTemp_Begin]
[MeterTubeRefTemp_End] |
|
| [OrificeCoefficientThermalExpansion_Begin]
[OrificeCoefficientThermalExpansion_End] |
|
| [OrificePlateBoreSize_Begin]
[OrificePlateBoreSize_End] |
|
| [OrificePlateMaterial_Begin]
[OrificePlateMaterial_End] |
|
| [OrificePlateRefTemp_Begin]
[OrificePlateRefTemp_End] |
|
| [PipeCoefficientThermalExpansion_Begin]
[PipeCoefficientThermalExpansion_End] |
|
| [PrimaryCalc_Begin]
[PrimaryCalc_End] |
|
| [SpAlarmHigh_Begin]
[SpAlarmHigh_End] |
|
| [SpAlarmLow_Begin]
[SpAlarmLow_End] |
|
| [SpCalibrateHigh_Begin]
[SpCalibrateHigh_End] |
|
| [SpCalibrateLow_Begin]
[SpCalibrateLow_End] |
|
| [SpTapLocation_Begin]
[SpTapLocation_End] |
|
| [SpTransducerRangeHigh_Begin]
[SpTransducerRangeHigh_End] |
|
| [SpTransducerRangeLow_Begin]
[SpTransducerRangeLow_End] |
|
| [SpType_Begin]
[SpType_End] |
|
| [TempAlarmHigh_Begin]
[TempAlarmHigh_End] |
|
| [TempAlarmLow_Begin]
[TempAlarmLow_End] |
|
| [TempCalibrateHigh_Begin]
[TempCalibrateHigh_End] |
|
| [TempCalibrateLow_Begin] [TempCalibrateLow_End] |
|
| [TempCalibrateZero_Begin] [TempCalibrateZero_End] |
|
| [TempTransducerRangeHigh_Begin] [TempTransducerRangeHigh_End] |
|
| [TempTransducerRangeLow_Begin] [TempTransducerRangeLow_End] |
|
| [UseCoriolisPressureEffect_Begin] [UseCoriolisPressureEffect_End] |
|
| [UseLiveTemp_Begin] [UseLiveTemp_End] |
|
| [WaterVaporCorrectionFactor_Begin] [WaterVaporCorrectionFactor_End] |
|
| [WellStreamFactor_Begin] [WellStreamFactor_End] |
|
| [CustomConfig1_Begin] [CustomConfig1_End] |
Custom-defined FMS configuration items See Remote Devices for your device type and FMS Configuration Items for more information. |
| [CustomConfig2_Begin] [CustomConfig2_End] |
|
| [CustomConfig3_Begin] [CustomConfig3_End] |
|
| [CustomConfig4_Begin] [CustomConfig4_End] |
|
| [CustomConfig5_Begin] [CustomConfig5_End] |
|
| [CustomConfig6_Begin] [CustomConfig6_End] |
|
| [CustomConfig7_Begin] [CustomConfig7_End] |
|
| [CustomConfig8_Begin] [CustomConfig8_End] |
|
| [CustomConfig9_Begin] [CustomConfig9_End] |
|
| [CustomConfig10_Begin] [CustomConfig10_End] |
|
| Gas Quality Tokens | |
| [Methane_Begin] [Methane_End] |
Methane (C1) |
| [Ethane_Begin] [Ethane_End] |
Ethane (C2) |
| [Propane_Begin] [Propane_End] |
Propane (C3) |
| [n-Butane_Begin] [n-Butane_End] |
n-Butane (C4) |
| [Isobutane_Begin] [Isobutane_End] |
Isobutane (isoC4) |
| [n-Pentane_Begin] [n-Pentane_End] |
n-Pentane (C5) |
| [Isopentane_Begin] [Isopentane_End] |
Isopentane (isoC5) |
| [Neopentane_Begin] [Neopentane_End] |
Neopentane (neoC5) |
| [n-Hexane_Begin] [n-Hexane_End] |
n-Hexane (C6) |
| [n-Heptane_Begin] [n-Heptane_End] |
n-Heptane (C7) |
| [n-Octane_Begin] [n-Octane_End] |
n-Octane (C8) |
| [n-Nonane_Begin] [n-Nonane_End] |
n-Nonane (C9) |
| [n-Decane_Begin] [n-Decane_End] |
n-Decane (C10) |
| [Argon_Begin] [Argon_End] |
Argon (Ar) |
| [CarbonDioxide_Begin] [CarbonDioxide_End] |
Carbon dioxide (CO2) |
| [CarbonMonoxide_Begin] [CarbonMonoxide_End] |
Carbon monoxide (CO) |
| [Helium_Begin] [Helium_End] |
Helium (He) |
| [Hydrogen_Begin] [Hydrogen_End] |
Hydrogen (H2) |
| [HydrogenSulfide_Begin] [HydrogenSulfide_End] |
Hydrogen sulfide (H2S) |
| [Nitrogen_Begin] [Nitrogen_End] |
Nitrogen (N2) |
| [Oxygen_Begin] [Oxygen_End] |
Oxygen (O2) |
| [Water_Begin] [Water_End] |
Water (H2O) |
| [Compressibility_Begin] [Compressibility_End] |
Compressibility |
| [DewPoint_Begin] [DewPoint_End] |
Dew point |
| [HeatingValueBasis_Begin] [HeatingValueBasis_End] |
Heating value basis |
| [HeatingValueMass_Begin] [HeatingValueMass_End] |
Heating value mass |
| [HeatingValueVolume_Begin]
[HeatingValueVolume_End] |
Heating value volume |
| [RelativeDensity_Begin]
[RelativeDensity_End] |
Relative density |
| [Viscosity_Begin]
[Viscosity_End] |
Viscosity |
| Units Tokens | |
| [AtmosphericPressure_Units] | The units used for atmospheric pressure data |
| [BasePressure_Units] | The units used for base pressure data |
| [BaseTemperature_Units] | The units used for base temperature data |
| [ConeDiameter_Units] | The units used for cone diameter data |
| [ConeCoefficientThermalExpansion_Units] | The units used for the cone thermal expansion coefficient |
| [CoriolisCalibrationPressure_Units] | The units used for coriolis calibration pressure |
| [CoriolisPressureEffect_Units] | The units used for coriolis pressure effect |
| [ConeRefTemp_Units] | The units used for cone reference temperature data |
| [DpAlarmHigh_Units] | The units used for DP high alarm data |
| [DpAlarmLow_Units] | The units used for DP low alarm data |
| [DpBackflowAlarm_Units] | The units used for DP backflow alarm data |
| [DpCalibrateHigh_Units] | The units used for DP high calibrate data |
| [DpCalibrateLow_Units] | The units used for DP low calibrate data |
| [DpTransducerRangeHigh_Units] | The units used for DP high transducer range data |
| [DpTransducerRangeLow_Units] | The units used for DP low transducer range data |
| [Elevation_Units] | The units used for elevation data |
| [FixedTemp_Units] | The units used for fixed temperature data |
| [FlowRateAlarmHigh_Units] | The units used for flow rate high alarm data |
| [FlowRateAlarmLow_Units] | The units used for flow rate low alarm data |
| [HeatingValueVolume_Units] | The units used for heating value volume data |
| [HeatingValueMass_Units] | The units used for heating value mass data |
| [KFactorMass_Units] | The units used for K factor mass |
| [KFactorVolume_Units] | The units used for K factor volume |
| [LowFlowCutoffDp_Units] | The units used for low flow cutoff differential pressure data |
| [LowFlowCutoffFlowRate_Units] | The units used for low flow cutoff volume flow rate data |
| [LowFlowCutoffMass_Units] | The units used for low flow cutoff mass flow rate data |
| [LowFlowCutoffPulseInterval_Units] | The units used for low flow cutoff pulse interval data |
| [MeterTubeInsideDiameter_Units] | The units used for meter tube inside diameter data |
| [MeterTubeRefTemp_Units] | The units used for meter tube reference temperature data |
| [OrificeCoefficientThermalExpansion_Units] | The units used for the orifice thermal expansion coefficient |
| [OrificePlateBoreSize_Units] | The units used for orifice plate bore size data |
| [OrificePlateRefTemp_Units] | The units used for orifice plate reference temperature data |
| [PipeCoefficientThermalExpansion_Units] | The units used for the pipe thermal expansion coefficient |
| [SpAlarmHigh_Units] | The units used for SP high alarm data |
| [SpAlarmLow_Units] | The units used for SP low alarm data |
| [SpCalibrateHigh_Units] | The units used for SP high calibrate data |
| [SpCalibrateLow_Units] | The units used for SP low calibrate data |
| [SpTransducerRangeHigh_Units] | The units used for SP high transducer range data |
| [SpTransducerRangeLow_Units] | The units used for SP low transducer range data |
| [TempAlarmHigh_Units] | The units used for high temperature alarm data |
| [TempAlarmLow_Units] | The units used for low temperature alarm data |
| [TempCalibrateHigh_Units] | The units used for high temperature calibration data |
| [TempCalibrateLow_Units] | The units used for low temperature calibration data |
| [TempCalibrateZero_Units] | The units used for zero temperature calibration data |
| [TempTransducerRangeHigh_Units] | The units used for high temperature transducer range data |
| [TempTransducerRangeLow_Units] | The units used for low temperature transducer range data |
| [Methane_Units] | The units used for Methane (C1) data |
| [Ethane_Units] | The units used for Ethane (C2) data |
| [Propane_Units] | The units used for Propane (C3) data |
| [n-Butane_Units] | The units used for n-Butane (C4) data |
| [Isobutane_Units] | The units used for Isobutane (isoC4) data |
| [n-Pentane_Units] | The units used for n-Pentane (C5) data |
| [Isopentane_Units] | The units used for Isopentane (isoC5) data |
| [Neopentane_Units] | The units used for Neopentane (neoC5) data |
| [n-Hexane_Units] | The units used for n-Hexane (C6) data |
| [n-Heptane_Units] | The units used for n-Heptane (C7) data |
| [n-Octane_Units] | The units used for n-Octane (C8) data |
| [n-Nonane_Units] | The units used for n-Nonane (C9) data |
| [n-Decane_Units] | The units used for n-Decane (C10) data |
| [Argon_Units] | The units used for Argon (Ar) data |
| [CarbonDioxide_Units] | The units used for Carbon dioxide (CO2) data |
| [CarbonMonoxide_Units] | The units used for Carbon monoxide (CO) data |
| [Helium_Units] | The units used for Helium (He) data |
| [Hydrogen_Units] | The units used for Hydrogen (H2) data |
| [HydrogenSulfide_Units] | The units used for Hydrogen sulfide (H2S) data |
| [Nitrogen_Units] | The units used for Nitrogen (N2) data |
| [Oxygen_Units] | The units used for Oxygen (O2) data |
| [Water_Units] | The units used for Water (H2O) data |
| [Viscosity_Units] | The units used for viscosity data |
Configuration report data changes table headers, which appear between #SubSection# DataChangesTableHeader and #End#, can be described by the following tokens, and by the text you enter. Type desired text into the cell, and format it as desired.
Note: In PDF format, reports containing tables that span multiple pages will repeat the data table header on each contiguous page.
| Token | Description |
|---|---|
| General Tokens | |
| [CurrentDeviceCount] | The index of the device being displayed |
| [TotalDeviceCount] | The total number of devices in the report |
| [NodeDesc] | The Node description |
| [NodeName] | The Node name |
| [NodePollingFacilityId] | The polling facility ID of the Node |
| [NodePollingFacilityTag] | The polling facility tag of the Node |
| [NodePollingSiteService] | The polling Site.Service of the Node |
| [NodeReportingFacilityId] | The reporting facility ID of the Node |
| [NodeReportingSiteService] | The reporting Site.Service of the Node |
Configuration report data changes table items, which appear between #SubSection# DataChangesTable (1 or 2) and #End#, can be described by the following tokens. Additionally, any configuration item parameter that appears in the data table can appear in the data change table if the data value changes; however any data value that changes only appears in the data change table if it is first configured to appear in the data table section.
Note: When gas analysis records are available within the specified time range, the shared token displays gas quality information from that source. See Gas Analysis and Gas Quality Data in the CygNet Measurement Concepts topic for a discussion about the relationship between gas quality and gas analysis records.
| Token | Description |
|---|---|
| General Tokens | |
| [=] | When used as the first three characters, turns the cell into a formula |
| [RowNumber] | The current row number |
| Configuration Tokens | |
| [ConfigLogItem] | The name of the configuration item parameter, from the data table |
| [ConfigLogAuditCategory] | The audit category for the record change |
| [ConfigLogAuditComment] | The audit comment for the record change |
| [ConfigLogAuditUserName] | The name of the user who created the record change |
| [ConfigLogDateTime] | The date/time of the record change |
| [ConfigLogValueNew] | The old value for the configuration item parameter |
| [ConfigLogValueOld] | The new value for the configuration item parameter |
| [ConfigLogValueUnits] | The value units for the parameter, if applicable |
| [PollingFac_Attr0] -
[PollingFac_Attr29] |
The polling facility indexed text attributes 0 through 29 (each a separate token) |
| [PollingFac_Category] | The polling facility category |
| [PollingFac_Desc] | The polling facility description |
| [PollingFac_Info0] | The polling facility info attribute 0
Default attribute name is Facility Location |
| [PollingFac_Info1] | The polling facility info attribute 1
Default attribute name is Facility Contact |
| [PollingFac_IsActive] | The polling facility active flag |
| [PollingFac_Table0] -
[PollingFac_Table29] |
The polling facility indexed table attributes 0 through 29 (each a separate token) |
| [PollingFac_Type] | The polling facility type |
| [PollingFac_YesNo0] -
[PollingFac_YesNo19] |
The polling facility indexed Yes/No attributes 0 through 19 (each a separate token) |
Configuration report subreport footers, which appear between #SubSection# SubReportFooter and #End#, can be described by the text you enter. Type the desired text into the cell, and format it as desired.
| Token | Description |
|---|---|
| General Tokens | |
| [=] | When used as the first three characters, turns the cell into a formula |
| [RowNumber] | The current row number |
| [FirstRow] | The row number of the first row in the data table |
| [LastRow] | The row number of the last row in the data table |
| [CurrentDeviceCount] | The index of the device being displayed |
| [TotalDeviceCount] | The total number of devices in the report |
| [NodeContractHour] | The contract hour of the Node |
| [NodeDaysOfData] | The number of days for which the data source of the Node will retain data |
| [NodeDesc] | The Node description |
| [NodeId] | The Node ID |
| [NodeInstallDateTime] | The install date/time for the Node, in Device time (D) |
| [NodeName] | The Node name |
| [NodePollingFacilityId] | The polling facility ID of the Node |
| [NodePollingFacilityTag] | The polling facility tag of the Node |
| [NodePollingSiteService] | The polling Site.Service of the Node |
| [NodeReportingFacilityId] | The reporting facility ID of the Node |
| [NodeReportingSiteService] | The reporting Site.Service of the Node |
| [NodeSecurityApp] | The security application of the Node |
| [NodeSortPriority] | The sort priority of the Node |
| [NodeTimezone] | The time zone configured for the Node |
| [NodeTimezoneUsingDst] | The daylight saving time status of the Node |
| [NodeType] | The Node type |
| [PollingFac_Attr0] -
[PollingFac_Attr29] |
The polling facility indexed text attributes 0 through 29 (each a separate token) |
| [PollingFac_Category] | The polling facility category |
| [PollingFac_Desc] | The polling facility description |
| [PollingFac_Info0] | The polling facility info attribute 0
Default attribute name is Facility Location |
| [PollingFac_Info1] | The polling facility info attribute 1
Default attribute name is Facility Contact |
| [PollingFac_IsActive] | The polling facility active flag |
| [PollingFac_Table0] -
[PollingFac_Table29] |
The polling facility indexed table attributes 0 through 29 (each a separate token) |
| [PollingFac_Type] | The polling facility type |
| [PollingFac_YesNo0] -
[PollingFac_YesNo19] |
The polling facility indexed Yes/No attributes 0 through 19 (each a separate token) |
| [RecordSpan] | The number of minutes in the record span |
Configuration report footers, which appear between #SubSection# ReportFooter and #End#, can be described by the text you enter. Type the desired text into the cell, and format it as desired.
|
|
|
